Identifies an XML string that defines the default properties of the grid.

Enables unit changes to be displayed in Run mode. Unit types affected are primary and alternate. Options are 0 — No and 1 — Yes. The default is 1 — Yes. If 0 — No is specified, the Use Alternate Units option is disabled in Run mode. Script subtype is Boolean.

For the Group Grid Tool, this change is a right-click option in the top, left cell.

Specifies that the object display values in alternate units instead of primary units. Alternate units must be defined in the point configuration record for the relevant point. Otherwise, alternate units cannot be displayed by the tool. Property sheet options are 0 — No and 1 — Yes. Default is 0 — No. Script subtype is Boolean.

[AutoRestart] specifies whether TheView automatically restarts when a user changes a Facility Navigation Bar object, a Group Grid object, or a Group Navigation Bar object.

[AutoRestart] is typically used to reset the Facility ID of TheView for templated objects. It is not required to reset the contents in a Group Grid object.

When used with a Facility Navigation Bar or a Group Navigation Bar, the [Facility] property of TheView is set to match the facility selected in the drop-down menu.

When used with a Group Grid object, the [Facility] property of TheView changes to match the Group Grid row when the row is clicked.

Use (1 - Yes) to enable. The default is 0 - No.

AutoSizeFont specifies whether the object’s font is automatically resized:

Shrink to Fit and Expand to Fit resize the font in Edit mode so that the text fits the boundary of the object. You can use these options to resize the font without using the object’s Font property to explicitly set the font size. In Run mode, the font is dynamically resized in Run mode to accommodate the [DisplayItem] or the tokens specified by the Text property.

• Shrink to Fit — reduces the font size so the text fits in the object boundary. If the object is resized in Run mode, the font size can never exceed the size specified by the object’s Font property.
• Expand to Fit — increases the font size so the text fills the object boundary. If the object is resized in Run mode, the font size can never be less than the size specified by the object’s Font property.
• Best Fit — resizes the font to best fit the text inside the object boundary. If the object is resized in Run mode, the font is also resized. This setting is a combination of Shrink to Fit and Expand to Fit.

Proportional and Proportional Fit resize the font in Run mode based on resizing of TheView.

• Proportional — resizes the font proportionally to TheView as TheView is resized.
• Proportional Fit — resizes the font proportionally to the object as the object is resized. This option reduces the font size only when necessary to view all of the text. This is the recommended option when font resizing is required.

Available AutoSizeFont options are 1 — Shrink to Fit, 2 — Expand to Fit, 3 — Best Fit, 4 — Proportional, and 5 — Proportional Fit. The default is 0 — No (no font resizing).

An object can be resized in Run mode only if its FlexHorizontal and FlexVertical properties are set to 2 - Expand or 3 - Proportional.

Available options are 1 - Shrink to Fit, 2 - Expand to Fit, 3 - Best Fit, 4 - Proportional, and 5 - Proportional Fit. The default is 0 - No (no font resizing).

Specifies whether the control will automatically initiate Run mode when its container changes to Run mode. Options are 0 — No or 1 — Yes. The default is 1 — Yes.

For the Group Grid Tool, AutoStart enables the Facility ID of each row to be automatically configured by a navigation bar. Set to 0 — No only when manually configuring the rows using script.

BackColor specifies a background color for the object or grid. Note that if an object’s [AlarmElement] property is set to Background Color and a primary point is assigned to the object, the background color will change in Run mode to reflect the point status.

The default is Automatic, which is the background color of TheView for most objects.

• For the Dynagraph Control, BackColor specifies the background color for the object, not the background color of the graph (plot area). See GraphBackgroundColor to change the background color of the graph. The default color is gray (RGB 240.240.240).
• For the GCM Nomination Grid, the default color is white (RGB 255.255.255).
• For the Group Grid Tool, BackColor specifies the background color for the object’s cell space. This does not affect the background color of the cells. To set the background color of the cells, enable UseCustomStateColors (Property Sheet, ActiveX page) and define the custom colors.
• For the SetPoint Button Tool, BackColor is a script property that specifies the background color of the value and the confirmation prompt dialog box for the SetPoint Button object. UsePrompt must be enabled for this setting to be recognized by the SetPoint Button object. Script subtype is long.
• For the Trend Tool, specifies the background color of a trend. Default is gray (RGB 240.240.240). Script subtype is long.

BorderStyle specifies the border style of the object boundary.

Most tools use one of these sets of options:

• 0 — ibsNone, 1 — ibsRaised, or 2 — ibsLowered, and the default is 0 — ibsNone

• 0 — None or 1 — Fixed Single, and the default is 0 — None

The Panel Switch Tool uses these options:

• 0 — ibsLine, 1 — ibsRaised, 2 — ibsLowered, 3 — ibsTop, and 4 — ibsNone, and the default is 0 — ibsLine.

For the Box, Frame, and Text tools, the BorderStyle property specifies the style of the object’s foreground lines. The options are:

• 0 — Normal, 1 — 3D, 2 — Sunken, 3 — Raised, and 4 — None

The default for the Box Tool is 0 — Normal. The default for the Frame Tool is 1 — 3D. The default for the Text Tool is 4 — None.

If you use 2 — Sunken or 3 — Raised and the effect is not visible, change the object’s HiliteColor.

If you use 0 — Normal, 2 — Sunken, or 3 — Raised, you can set the border width using the PenWidth property.

For TheFrame/TheView, the BorderStyle property specifies both the style of the object's border and whether the object can be resized by the user in Run mode. The default is 0 — Thin, which means the border is thin and the size is static. The other possible option is 1 — Resizing, which means the border is thicker and can be resized.

See also Appearance.

Script subtype is integer.

Bottom specifies the distance (in pixels) from the top of TheView’s scroll region to the bottom of the object. You can dynamically change this value in Edit mode if you use the mouse to enlarge or shrink the object. See Sizing and Positioning Objects.

Specifies the background color of a cell. Default is white (RGB 255.255.255).

Specifies the alarm element for the specified column. See the Alarm Element As Long table for a list of possible values.

Selects an XML string that defines the default properties of the column.

Enables or disables blinking when the point status is not acknowledged. True — enables. False — disables.

Specifies the display element for the specified column.

Specifies the display format for the specified column. The format string is a Microsoft Visual Basic format string.

Specifies the display item for the specified column. The display item can be set as a string or a number. Get returns an item number only.

Specifies the Facility for the specified column.

Specifies the label text for the specified column.

Specifies the Site.Service for the specified column.

Specifies Sort Type for the specified column.

Specifies the Text Alignment for the specified column.

Specifies the Text Overflow option for the specified column.

Specifies Tokenized Text for a specified column.

Specifies a UDC for the specified column.

Specifies the number of columns that are defined for the object or the XML that represents the list of displayed columns. Use the OCX Properties dialog box to select.

For a WatchList Tool, Columns specifies the identifier of each column. Items are semicolon separated.

Selects the Unknown Tag option for the specified column.

ContextMenuXml identifies an XML string that defines the contents and Event IDs for the object’s custom context menu. See Custom Context Menus for more information about configuring custom menus for ActiveX Controls.

ActiveX Control Example

The following example includes one new menu item (New Item).

1
2
3
4
5
6
7
8
9
10
<CustomContextMenu>
    <items>
        <ContextMenuDef>
            <itemsHidden/>
            <items>
                    <MenuItem Disable1="false" Disable2="false" Disable3="false" Description="New Context Menu Item (at bottom)" EventID="NEWID"/>
            </items>
        </ContextMenuDef>
    </items>
</CustomContextMenu>

CAS View Control Example

The CAS View Control includes additional options to hide default menu items. The following example includes one new menu item (New Item) and one hidden item (Suppress…). See CAS View Control.

1
2
3
4
5
6
7
8
9
10
11
12
<CustomContextMenu>
    <items>
        <ContextMenuDef>
            <itemsHidden>
                <DefaultMenuItem MenuId="1021" Desc="Suppress..." Type="0"/>
            </itemsHidden>
            <items>
                <MenuItem Disable1="true" Disable2="false" Disable3="false" Description="New Item" EventID="NEWID"/>
            </items>
        </ContextMenuDef>
    </items>
</CustomContextMenu>

Specifies text that is displayed in the top, left cell of the grid. In Run mode, this cell has inherent right-click options (trend, export, show row numbers, and so on). Use the OCX Properties dialog box (Default page, Label property) to define.

For TheView, CursorPointer selects the cursor icon that appears when you mouse over objects.

For objects, CursorPointer selects the cursor icon for the instance of the object. The object’s cursor pointer takes precedence over TheView’s cursor pointer.

The default is 0 — Default. For TheView, this is an arrow. For other objects, the icon configured for TheView is used. Other options are:

• 1 — Arrow
• 2 — IBeam
• 3 — Cross
• 4 — UpArrow
• 5 — NoDrop
• 6 — Help
• 99 — HotSpot
• 100 — Timer

Script subtype is long.

Enable specifies whether the user is able to interact with the object. Options are 0 — No and 1 — Yes. The default is 1 — Yes. If set to 0 — No, the object is still visible but its context menu is disabled.

Other options:

• Completely hide the object in run mode using the Visible property.
• Display the object but hide its [DisplayItem] using the [DisplayElement] property.

Enables the selection frame around the entire row (shown when a user clicks on a row in Run mode). Default is 1 — Yes. If set to 0 — No the selection frame is shown only on the cell. This property is visual only. It does not affect the [AutoRestart] property.

Enables the trending options on the right-click menu in Run mode. Default is 1 — Yes.

The relevant facility here. This facility is typically that of the dynagraph-enabled remote device from which you want to collect dynagraph data. Script subtype is string.

FlexHorizontal specifies whether the object moves or resizes horizontally or is unchanged when TheFrame is resized. Options are:

• 0 — None (no resizing occurs)
• 1 — Shift (the object is shifted)
• 2 — Expand (the object expands or shrinks the same number of pixels as TheFrame)
• 3 — Proportional (the object expands or shrinks proportionally to TheFrame)

Default is 0 — None.

FlexVertical specifies whether the object moves or resizes vertically when TheFrame is resized. Options are:

• 0 — None (no resizing occurs)
• 1 — Shift (the object is shifted)
• 2 — Expand (the object expands or shrinks the same number of pixels as TheFrame)
• 3 — Proportional (the object expands or shrinks proportionally to TheFrame)

Default is 0 — None.

Font specifies the font for the object.

For TheView, this property specifies the default font for text-based objects.

For other objects, it specifies the font for the instance of the object. The object’s font takes precedence over the font set for TheView.

Click … to view the Font dialog box, which you can use to configure the font. The default is MS Shell Dlg (MS Sans Serif, regular, 8 pt). Script subtype is string.

ForeColor specifies the foreground color for the object. The default is Automatic, which, for most objects is black. Note that if the object’s [AlarmElement] is set to Foreground Color and a primary point has been assigned to the object, the foreground color will change in Run mode to reflect the point status.

Group groups objects into a discrete sequence that can be navigated using the arrow keys.

Options are 0 — No and 1 — Yes. The default is 0 — No.

To use this property:

1. Add objects that use the Group property to a screen.

2. Position them as you like (typically in a spatial configuration that reflects the order in which they were added to the screen).

3. Decide where in the spatial configuration logical groups begin and end.

4. Mark the beginning of a group by setting the Group property to 1 — Yes for the first object in the group.

5. Set Group set to 0 — No for other objects in the group.

The group is made up of all objects that 1) are added sequentially after an object with a Group property set to 1 — Yes and 2) that use a Group property set to 0 — No. A group's arrow navigation sequence reflects the order in which its objects were added to a screen.

This property is not related to the Draw > Group option in the CygNet Studio menu bar. This property might not be suited for use with all tools that include the Group property.

Script subtype is long.

See also Tabstop.

Specifies the GroupID of the object group.

Returns a Boolean value to confirm a CygNet-aware tool is associated with a valid CygNet tag. This property may not be suited for use with all tools that include the HasValidTag property. See also CygNet-Aware Tools. Script subtype is Boolean.

HelpContextID specifies the object’s help identifier for context-sensitive help. TheFrame’s WhatsThisHelp must be enabled.

Script subtype is long.

Returns a Boolean value that confirms that an object is a CygNet-aware tool. This property might not be suited for use with all tools that include the IsCygNetAware property. Script subtype is Boolean. See also CygNet-Aware Tools.

Enables maintain cell selection when the sort order is changed. Default is 1 — Yes.

Layer identifies the layer on which the object resides. Script subtype is Boolean.

Left specifies the distance (in pixels) from the left edge of TheView’s scroll region to the left edge of the object. See Sizing and Positioning Objects.

Specifies the ID of the Group Navigation Bar object that will set the facilities in the Group Grid object.

(ObjectCode) specifies a unique identifier of the object. You can enter up to 39 characters. Valid characters are A-Z, 0-9, and underscore (_). Spaces are not allowed. The default is the object name and the numeric instance. Script subtype is string.

Displays the OCXProperty dialog box unique to the object.

Specifies the text and text tokens for the report footer when printing the grid.

Specifies the text and text tokens for the report header when printing the grid.

Right specifies the distance (in pixels) from the left edge of TheView’s scroll region to the right edge of the object. See Sizing and Positioning Objects.

Causes the object to rotate clockwise the specified number of degrees. You can rotate an object directly by using the Rotate option on the Draw menu. For details, see Rotating an Object.

Gets/sets an XML string that defines the default properties of the row.

Gets/sets the Facility ID for the specified row.

Specifies the information to display as the row label. The default is Facility, which is the ID of the Facility. Other options are Facility Tag (SITE.SERVICE::FACILITYID), SiteService (the Site.Service of the facility), and Node Description (the description of the node from the navigation hierarchy, which is generally the facility description).

Gets/sets the label text for the specified row.

Gets/sets the Site.Service for the specified row.

Gets/sets the UDC for the specified row.

[SiteService] identifies the CVS, Facility Service, or Group Service for the settings. The format for the value is Site.Service.

If this field is blank, the Site.Service specified for TheView is used. If Site.Service is defined for both TheView and the object, the value specified for the object is used.

[StateColorMode] Specifies if and how the object will show the alarm point’s state color: shown in a single color (1 — Single), dual colors (2 — Dual), or not at all (0 — Off). The default is Single. Options include:

• Off (0 — eSTATECOLORMODE_OFF)
• Single Color (1 — eSTATECOLORMODE_SINGLE)
• Dual Colors (2 — eSTATECOLORMODE_DUAL)

Most tools have a Single mode. That is, they can reflect the point state color in a single element. The element is defined by an object’s [AlarmElement] property to specify if the state color will be shown in the object’s foreground or background. Objects that have [AlarmElement] options of both Foreground Color and Background Color, such as the Text Tool or a closed shape (ellipse, rectangle, polyline), can be configured using the [StateColorMode] property to show the point state color in dual mode; that is, both the Foreground and Background. For tools with a Dual mode, you must select the foreground and background colors using the [UseCustomStateColors] property. The default is 1 — eOFF. Options include:

• 1 — eOFF
• 2 — eSINGLE_FOREGROUND
• 3 — eSINGLE_BACKGROUND
• 4 — eDUAL

Tabstop specifies whether the focus stops on the object when you use the Tab key to navigate between objects (in other words, enables the object as a tab stop). Options are 0 — No and 1 — Yes. Default is 1 — Yes.

Script subtype is long.

See also Group and Tab Order.

Tag is an extra field for application-specific purposes. Does not specify a CygNet point. Default is blank. Script subtype is string.

TooltipText identifies text that is displayed when the mouse hovers over the object in Run mode. For some objects, tooltip text can be dynamic, static, or a combination. You build dynamic text with tokens that can represent point configuration, facility, and CVS point record properties. You can also specify data formatting. Click … to view the Edit Tooltip Text dialog box you use to configure the text.

For information about building dynamic text using tokens, see Using Text Tokens.

Script subtype is string.

Returns a CygNet-defined string value that describes the object type. This value appears in the Status Bar when you hover over a default control in its tool palette. You can also display the value using a script. This property is read only. See also Rule-Based Substitution.

Script subtype is string.

Top specifies the distance (in pixels) from the top of TheView’s scroll region to the top of the object. See Sizing and Positioning Objects.

For TheView, this property specifies the rate (in milliseconds) at which TheView requests new data from the services (that is, the rate at which TheView is refreshed). Valid range is any integer between 100 to 1000000000. The default is 1000.

For the Group Grid Tool, this property specifies the rate (in milliseconds) at which the grid requests data from the cache. Valid range is any integer from 100 to 1000000000. Default is 100.

Script subtype is long.

[UseCustomStateColors] enables the use of the [CustomStateColors].

• For TheView, this property enables use of TheView’s [CustomStateColors]. Default is 1 — Yes.
• For objects, this property enables use of the object’s [CustomStateColors]. Default is 1 — Yes.

If this property is set to 0 — No for an object and is set to 1 — Yes for TheView, the object will use the custom state colors of TheView.

Enables the object to use the [Units] property of TheView or the parent view (for the Nested View Tool) rather than its own units. Default is 0 — No.